/*---------------------------------------------------------------------------*\
    CFDEMcoupling - Open Source CFD-DEM coupling

    CFDEMcoupling is part of the CFDEMproject
    www.cfdem.com
                                Christoph Goniva, christoph.goniva@cfdem.com
                                Copyright 2009-2012 JKU Linz
                                Copyright 2012-     DCS Computing GmbH, Linz
-------------------------------------------------------------------------------
License
    This file is part of CFDEMcoupling.

    CFDEMcoupling is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by the
    Free Software Foundation; either version 3 of the License, or (at your
    option) any later version.

    CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with CFDEMcoupling; if not, write to the Free Software Foundation,
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Description
    This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
    and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).

    ArchimedesIB buoyancy force for sphere / cylinder (2d)
    basic "on-off" handling of buoyancy at the interface

	Contribution by Alice Hager.

Class
    ArchimedesIB

SourceFiles
    ArchimedesIB.C

\*---------------------------------------------------------------------------*/

#ifndef ArchimedesIB_H
#define ArchimedesIB_H

#include "forceModel.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                           Class ArchimedesIB Declaration
\*---------------------------------------------------------------------------*/

class ArchimedesIB
:
    public forceModel
{
private:

    dictionary propsDict_;

    bool twoDimensional_;

    word voidfractionFieldName_;

    const volScalarField& voidfractions_;

    word gravityFieldName_;

    #ifdef version21
        const uniformDimensionedVectorField& g_;    // ref to gravity
    #elif defined(version16ext) || defined(version15)
        const dimensionedVector& g_;    // ref to gravity
    #endif


public:

    //- Runtime type information
    TypeName("ArchimedesIB");


    // Constructors

        //- Construct from components
        ArchimedesIB
        (
            const dictionary& dict,
            cfdemCloud& sm
        );

    // Destructor

        ~ArchimedesIB();


    // Member Functions
        void setForce() const;
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //
